<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>static_buffer</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
<link rel="prev" href="boost__beast__ssl_stream/write_some/overload2.html" title="ssl_stream::write_some (2 of 2 overloads)">
<link rel="next" href="boost__beast__static_buffer/base.html" title="static_buffer::base">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__ssl_stream/write_some/overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__static_buffer/base.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="beast.ref.boost__beast__static_buffer"></a><a class="link" href="boost__beast__static_buffer.html" title="static_buffer">static_buffer</a>
</h4></div></div></div>
<p>
        A circular <span class="bold"><strong>DynamicBuffer</strong></span> with a fixed size
        internal buffer.
      </p>
<h5>
<a name="beast.ref.boost__beast__static_buffer.h0"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__static_buffer.synopsis"></a></span><a class="link" href="boost__beast__static_buffer.html#beast.ref.boost__beast__static_buffer.synopsis">Synopsis</a>
      </h5>
<p>
        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/static_buffer.hpp" target="_top">boost/beast/core/static_buffer.hpp</a>&gt;</code>
      </p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">N</span><span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">static_buffer</span> <span class="special">:</span>
    <span class="keyword">public</span> <span class="identifier">static_buffer_base</span>
</pre>
<h5>
<a name="beast.ref.boost__beast__static_buffer.h1"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__static_buffer.types"></a></span><a class="link" href="boost__beast__static_buffer.html#beast.ref.boost__beast__static_buffer.types">Types</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/const_buffers_type.html" title="static_buffer::const_buffers_type"><span class="bold"><strong>const_buffers_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The type used to represent the input sequence as a list of buffers.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/mutable_buffers_type.html" title="static_buffer::mutable_buffers_type"><span class="bold"><strong>mutable_buffers_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The type used to represent the output sequence as a list of buffers.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__static_buffer.h2"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__static_buffer.member_functions"></a></span><a class="link" href="boost__beast__static_buffer.html#beast.ref.boost__beast__static_buffer.member_functions">Member Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/base.html" title="static_buffer::base"><span class="bold"><strong>base</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Returns the static_buffer_base portion of this object.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/capacity.html" title="static_buffer::capacity"><span class="bold"><strong>capacity</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Return the maximum sum of input and output sizes that can be held
                  without an allocation.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/commit.html" title="static_buffer::commit"><span class="bold"><strong>commit</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Move bytes from the output sequence to the input sequence.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/consume.html" title="static_buffer::consume"><span class="bold"><strong>consume</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Remove bytes from the input sequence.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/data.html" title="static_buffer::data"><span class="bold"><strong>data</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get a list of buffers that represent the input sequence.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/max_size.html" title="static_buffer::max_size"><span class="bold"><strong>max_size</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Return the maximum sum of the input and output sequence sizes.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/mutable_data.html" title="static_buffer::mutable_data"><span class="bold"><strong>mutable_data</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get a mutable list of buffers that represent the input sequence.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/operator_eq_.html" title="static_buffer::operator="><span class="bold"><strong>operator=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Assignment.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/prepare.html" title="static_buffer::prepare"><span class="bold"><strong>prepare</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get a list of buffers that represent the output sequence, with
                  the given size.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/size.html" title="static_buffer::size"><span class="bold"><strong>size</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Return the size of the input sequence.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/static_buffer.html" title="static_buffer::static_buffer"><span class="bold"><strong>static_buffer</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Constructor.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__static_buffer.h3"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__static_buffer.protected_member_functions"></a></span><a class="link" href="boost__beast__static_buffer.html#beast.ref.boost__beast__static_buffer.protected_member_functions">Protected
        Member Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody><tr>
<td>
                <p>
                  <a class="link" href="boost__beast__static_buffer/reset.html" title="static_buffer::reset"><span class="bold"><strong>reset</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Reset the pointed-to buffer.
                </p>
              </td>
</tr></tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__static_buffer.h4"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__static_buffer.description"></a></span><a class="link" href="boost__beast__static_buffer.html#beast.ref.boost__beast__static_buffer.description">Description</a>
      </h5>
<p>
        This implements a circular dynamic buffer. Calls to <a class="link" href="boost__beast__static_buffer/prepare.html" title="static_buffer::prepare"><code class="computeroutput"><span class="identifier">static_buffer</span><span class="special">::</span><span class="identifier">prepare</span></code></a> never require moving memory.
        The buffer sequences returned may be up to length two. Ownership of the underlying
        storage belongs to the derived class.
      </p>
<h5>
<a name="beast.ref.boost__beast__static_buffer.h5"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__static_buffer.template_parameters"></a></span><a class="link" href="boost__beast__static_buffer.html#beast.ref.boost__beast__static_buffer.template_parameters">Template
        Parameters</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Type
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody><tr>
<td>
                <p>
                  <code class="computeroutput"><span class="identifier">N</span></code>
                </p>
              </td>
<td>
                <p>
                  The number of bytes in the internal buffer.
                </p>
              </td>
</tr></tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__static_buffer.h6"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__static_buffer.remarks"></a></span><a class="link" href="boost__beast__static_buffer.html#beast.ref.boost__beast__static_buffer.remarks">Remarks</a>
      </h5>
<p>
        To reduce the number of template instantiations when passing objects of this
        type in a deduced context, the signature of the receiving function should
        use <a class="link" href="boost__beast__static_buffer_base.html" title="static_buffer_base"><code class="computeroutput"><span class="identifier">static_buffer_base</span></code></a> instead.
      </p>
<h5>
<a name="beast.ref.boost__beast__static_buffer.h7"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__static_buffer.see_also"></a></span><a class="link" href="boost__beast__static_buffer.html#beast.ref.boost__beast__static_buffer.see_also">See
        Also</a>
      </h5>
<p>
        <a class="link" href="boost__beast__static_buffer_base.html" title="static_buffer_base"><code class="computeroutput"><span class="identifier">static_buffer_base</span></code></a>
      </p>
<p>
        Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2016, 2017 Vinnie Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__ssl_stream/write_some/overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__static_buffer/base.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
